Package com.cisco.pt.ipc.sim.impl
Class PolicyMapImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.PolicyMapImpl
Information provided by the PKI file:
\class PolicyMap
\brief PolicyMap handles and manipulates policy maps.
\example network().getDevice("Router0").getPolicyMapManager().getPolicyMapAt(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionPolicyMapImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptiongetClassAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidsetMapType(MapType mapType) Information provided by the PKI file:toString(boolean isAsa) Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
PolicyMapImpl
public PolicyMapImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getClassCnt
public int getClassCnt()Information provided by the PKI file:
\brief Returns the number of policies. \return int, the number of policies.- Specified by:
getClassCntin interfacePolicyMap- Returns:
- int Returns a int
-
getClassAt
Information provided by the PKI file:
\brief Returns QoS class at the specified index. \param index, the index of the QoS class of interest. \return PolicyMapQosClass, the PolicyMapQosClass object.- Specified by:
getClassAtin interfacePolicyMap- Parameters:
index- Takes in a parameter of index- Returns:
- PolicyMapQosClass Returns a PolicyMapQosClass
-
getTotalBandwidth
public int getTotalBandwidth()Information provided by the PKI file:
\brief Returns the total bandwidth value. \return int, the total bandwidth value.- Specified by:
getTotalBandwidthin interfacePolicyMap- Returns:
- int Returns a int
-
getTotalBandwidthPercent
public int getTotalBandwidthPercent()Information provided by the PKI file:
\brief Returns the total bandwidth percentage. \return int, the total bandwidth percentage.- Specified by:
getTotalBandwidthPercentin interfacePolicyMap- Returns:
- int Returns a int
-
getTotalBandwidthRemainPercent
public int getTotalBandwidthRemainPercent()Information provided by the PKI file:
\brief Returns the total bandwidth remaining percentage. \return int, the total bandwidth remaining percentage.- Specified by:
getTotalBandwidthRemainPercentin interfacePolicyMap- Returns:
- int Returns a int
-
isBandwidthConfigured
public boolean isBandwidthConfigured()Information provided by the PKI file:
\brief Returns true if the bandwidth value is configured, otherwise false. \return bool, true if the bandwidth value is configured, otherwise false.- Specified by:
isBandwidthConfiguredin interfacePolicyMap- Returns:
- boolean Returns a boolean
-
isPriorityConfigured
public boolean isPriorityConfigured()Information provided by the PKI file:
\brief Returns true if the priority is configured, otherwise false. \return bool, true if the priority is configured, otherwise false.- Specified by:
isPriorityConfiguredin interfacePolicyMap- Returns:
- boolean Returns a boolean
-
isFairQueueConfigured
public boolean isFairQueueConfigured()Information provided by the PKI file:
\brief Returns true if fair queue is configured, otherwise false. \return bool, true if fair queue is configured, otherwise false.- Specified by:
isFairQueueConfiguredin interfacePolicyMap- Returns:
- boolean Returns a boolean
-
isShapeConfigured
public boolean isShapeConfigured()Information provided by the PKI file:
\brief Returns true if traffic shaping is configured, otherwise false. \return bool, true if traffic shaping is configured, otherwise false.- Specified by:
isShapeConfiguredin interfacePolicyMap- Returns:
- boolean Returns a boolean
-
hasOutputFeature
public boolean hasOutputFeature()Information provided by the PKI file:
\brief Returns true if the policy map has output feature, otherwise false. \return bool, true if the policy map has output feature, otherwise false.- Specified by:
hasOutputFeaturein interfacePolicyMap- Returns:
- boolean Returns a boolean
-
hasGtsFeature
public boolean hasGtsFeature()Information provided by the PKI file:
\brief Returns true if the policy map has GTS feature, otherwise false. \return bool, true if the policy map has GTS feature, otherwise false.- Specified by:
hasGtsFeaturein interfacePolicyMap- Returns:
- boolean Returns a boolean
-
updateOutputPort
public void updateOutputPort()Information provided by the PKI file:
\brief Updates the output port.- Specified by:
updateOutputPortin interfacePolicyMap
-
getMapName
Information provided by the PKI file:
\brief Returns the name of the policy map. \return string, the name of the policy map.- Specified by:
getMapNamein interfacePolicyMap- Returns:
- String Returns a String
-
getMapType
Information provided by the PKI file:
\brief Returns the type of the policy map. \return QoS::eMapType, the type of the policy map. Map types: type_default = 0, type_control = 1, type_inspect = 2, type_asaInspect = 3, type_logging = 4- Specified by:
getMapTypein interfacePolicyMap- Returns:
- MapType Returns a MapType
-
setMapType
Information provided by the PKI file:
\brief Sets the type of the policy map. \param mapType, the type of the policy map. Map types: type_default = 0, type_control = 1, type_inspect = 2, type_asaInspect = 3 type_logging = 4- Specified by:
setMapTypein interfacePolicyMap- Parameters:
mapType- Takes in a parameter of mapType
-
toString
Information provided by the PKI file:
\brief Returns the name of the policy map. \return string, the name of the policy map.
-